home *** CD-ROM | disk | FTP | other *** search
/ The Arsenal Files 6 / The Arsenal Files 6 (Arsenal Computer).ISO / internet / ircdor11.zip / IRCDOOR.DOC < prev    next >
Text File  |  1996-03-15  |  30KB  |  740 lines
  1.  
  2.  
  3. IRCDOOR 1.00 Manual
  4. Copyright (c) 1996 by Andrew Eigus
  5.  
  6.  
  7.                    Table of Contents
  8.  
  9.  
  10.             1.  ...Introduction
  11.  
  12.         2.  ...Software and Hardware requirements
  13.  
  14.         3.  ...License agreement
  15.  
  16.         4.  ...Disclaimer
  17.  
  18.         5.  ...Installation instructions
  19.  
  20.             6.  ...IRC commands supported by IRCDOOR/2
  21.  
  22.             7.  ...IRCDOOR/2-specific commands
  23.  
  24.         8.  ...Comments
  25.  
  26.             9.  ...Registration information
  27.  
  28.         10. ...IRCDOOR/2 distribution information
  29.  
  30.             11. ...Contact information
  31.  
  32.  
  33.  
  34.  
  35.  
  36.     1.    Introduction
  37.  
  38.     What is IRC?
  39.  
  40.     IRC stands for "Internet Relay Chat". It was originally
  41.     written by Jarkko Oikarinen (jto@tolsun.oulu.fi) in 1988.
  42.     Since starting in Finland, it has been used in over 60
  43.     countries around the world. It was designed as a replacement
  44.     for the "talk" program but has become much much more than
  45.     that. IRC is a multi-user chat system, where people convene
  46.     on "channels" (a virtual place, usually with a topic of
  47.     conversation) to talk in groups, or privately. IRC is
  48.     constantly evolving, so the way things to work one week may
  49.     not be the way they work the next. 
  50.  
  51.     Good, what is IRCDOOR?
  52.  
  53.     IRCDOOR/2 is an advanced 32-bit OS/2 Internet Relay Chat
  54.     client with main purpose of being able to be run from a BBS
  55.     (Bulletin Board System) as an external door program, that
  56.     would allow BBS users to IRC. Yes, it means that you could
  57.     *dramatically* increase your BBS popularity by adding IRC
  58.     service for your BBS users. Imagine a user that finds out
  59.     that something is much bigger, better and international than
  60.     a simple teleconferencing on BBS! Imagine a user who opens
  61.     your Internet service menu and starts the chat session on
  62.     the Internet! How does it sound now?
  63.  
  64.     The following is a brief list of features that are supported
  65.     in current version of IRCDOOR/2:
  66.  
  67.     -- natural 32-bit application capable of running simultaneously
  68.            at as many lines as you wish to register it for
  69.     -- as a BBS door supports TTY/ANSI interface
  70.     -- supports DORINFO1/DOORSYS drop-file formats
  71.     -- supports most standard IRCII 2.8 commands plus some
  72.        additional /CTCP-request commands and some specific
  73.        to IRCDOOR-only commands eg: /WHOELSE, /TIMELEFT, etc.
  74.     -- easy to setup (most options can be specified via command
  75.        line)
  76.     -- can be run in local mode too as a normal IRC client program
  77.     -- runs from any native OS/2 BBS that supports "hot" (open)
  78.        com port handles
  79.     -- flexible configuration
  80.     -- extensive Maximus BBS support (MEX code provided)
  81.     -- custom colors and other settings through config file
  82.  
  83.  
  84.  
  85.     2.    Software and Hardware requirements
  86.  
  87.     Requires IBM PC (80486 is recommended), Internet connection
  88.     via ethernet, SLIP/PPP etc., IBM OS/2 version 2.0 or 3.0 and
  89.     IBM IAK (Internet Access Kit) with 32-bit TCP/IP libraries
  90.     (files: TCP32DLL.DLL and and SO32DLL.DLL).
  91.  
  92.  
  93.     3.    License agreement
  94.  
  95.     IRCDOOR/2 IS COPYRIGHT AND PROPERTY OF ANDREW EIGUS, AN
  96.     INDEPENDENT SOFTWARE DEVELOPER (FREELANCER). NONE OF THE
  97.     PORTIONS CONTAINED IN THE IRCDOOR/2 DISTRIBUTION PACKAGE CAN
  98.     BE RESELLED, MODIFIED, DISASSEMBLED OR REPRODUCED IN ANY WAY
  99.     WITHOUT THE AUTHOR'S PERMISSION. PERMISSION IS GRANTED TO
  100.     ANYONE TO DISTRIBUTE THE ENTIRE PACKAGE IN THE NON-MODIFIED
  101.     FORM, PROVIDED THAT ALL FILES ARE KEPT IN THE DISTRIBUTION
  102.     ARCHIVE.
  103.  
  104.     IRCDOOR/2 IS NEITHER PUBLIC DOMAIN, NOR FREEWARE. IRCDOOR IS
  105.     SHAREWARE SOFTWARE. YOU MAY EVALUATE IT FOR A PERIOD OF 28
  106.     DAYS, AND THEN WHETHER TO REGISTER IT, OR TO DISCONTINUE
  107.     USING IT. 
  108.  
  109.  
  110.     4.    Disclaimer
  111.  
  112.  
  113.     THIS SOFTWARE PROVIDED "AS-IS", WHICH MEANS THAT THERE IS
  114.     ABSOLUTELY NO WARRANTY PROVIDED BY THE AUTHOR. IN NO EVENT
  115.     THE AUTHOR WILL BE LIABLE TO YOU FOR ANY DAMAGES ARISING OUT
  116.     OF THE USE OF ANY PART OF THIS PROGRAM.
  117.  
  118.  
  119.     5.    Installation instructions
  120.  
  121.     Installation instructions are sub-divided in two sections.
  122.     Section 5.1 describes the door installation details for non-
  123.     Maximus BBS users, and Maximus SysOps should probably skip
  124.      this section and see section 5.2.
  125.  
  126.  
  127.     5.1    Installation for non-Maximus BBS systems
  128.  
  129.     a) Create an empty subdirectory in your BBS [doors]
  130.        directory called IRCDOOR. Let's say i am using Lora BBS,
  131.        and a path to my door games is C:\LORA\DOORS\, so i
  132.        create a directory C:\LORA\DOORS\IRCDOOR.
  133.  
  134.     b) Unzip the distribution IRCDOOR archive to that directory,
  135.        so it would contain AT LEAST the two following files:
  136.  
  137.             IRCDOOR.EXE
  138.        IRCDOOR.CFG
  139.             IRCDOOR.HLP
  140.  
  141.     c) Next, set up your BBS software for this door to be run; use
  142.        either DOOR.SYS (recommended) or DORINFO?.DEF format drop-
  143.        file. It should be created prior to running IRCDOOR by your
  144.        BBS software (see your BBS manual for details). Your BBS
  145.        software might be able to pass some information to IRCDOOR
  146.        via command-line: IRC server name, port number, etc. Even
  147.        some parameters in the drop-file can be overriden through
  148.        command-line. See command-line switches in the Comments
  149.        section for more information about IRCDOOR/2 command line
  150.        parameters.
  151.  
  152.           Your BBS software MUST be able to pass an open com port
  153.        "handle" parameter to IRCDOOR. IRCDOOR will NOT work in
  154.        the remote mode without port handle and BBS drop file path
  155.        specified as command-line arguments. (see -p and -d options
  156.        in the command line parameters paragraph). I recommend you
  157.        to create an OS/2 command file, for example IRCDOOR.CMD,
  158.           that will run the door. Here is sample command file:
  159.  
  160.  
  161.            @echo off
  162.            cd \lora\doors\ircdoor
  163.            if "%1"=="" goto local
  164.            if "%1"=="0" goto local
  165.  
  166.            :remote
  167.            ircdoor -p%1 -dc:\lora\node%2\door.sys -sirc.funet.fi -$6666
  168.            goto quit
  169.  
  170.            :local
  171.            ircdoor -l -uSysOp -nSysOp -r"My Name" -sirc.funet.fi $6666
  172.            goto quit
  173.  
  174.            :quit
  175.            cd \lora
  176.  
  177.         This small command file above will do the job. It requires
  178.        two arguments: 1 - "hot" com port handle and 2 - path to BBS
  179.        drop file where to take user information from. IRCDOOR will
  180.        automatically determine drop file type by it's name. See
  181.        information on command line switches for more information.
  182.  
  183.     d) Edit your STARTUP.CMD file in your system root directory
  184.        and add there the following line:
  185.  
  186.         erase c:\ircdoor_home_directory\nodeinfo.* >nul
  187.  
  188.        This command will erase old node information files from the
  189.        IRCDOOR home directory. Ircdoor_home_directory must be
  190.        replaced with the directory name where IRCDOOR/2 files are
  191.        located.
  192.  
  193.        IRCDOOR/2 creates and uses nodeinfo.* files in it's home
  194.        directory and it automatically deletes them when a user
  195.        exits the door. But if you encounter a system crash during
  196.        the time when IRCDOOR is running, you should manually
  197.        remove nodeinfo.* files from it's home directory to prevent
  198.        IRCDOOR from thinking that it is running at the moment.
  199.        That's why the best way to avoid this is to insert that
  200.        mentioned erase command above to your STARTUP.CMD file so
  201.        whenever your system reboots, old IRCDOOR node information
  202.        files will be deleted.
  203.  
  204.     There are many different types of BBS software for OS/2, and
  205.     most support passing various parameters via command line, and
  206.     most are able to write standard BBS drop-files (DOOR.SYS or
  207.     DORINFO?.DEF). If this is not your case, and you are
  208.     experiencing problems on how to setup a door, please contact
  209.     me at the address given at the bottom of this document.
  210.  
  211.  
  212.     5.2    Installation (for Maximus 3.x systems)
  213.  
  214.         * Assume that your Maximus directory is C:\MAX, and your doors
  215.       are in C:\MAX\DOORS. Assume that your MEX directory is
  216.       C:\MAX\M, and your MECCA directory is C:\MAX\MISC. If this
  217.       is not your case, simply replace the paths where they
  218.       appear in future.
  219.  
  220.     a) Create IRCDOOR directory under your DOORS directory:
  221.        C:\MAX\DOORS\IRCDOOR.
  222.  
  223.     b) Unzip (copy) IRCDOOR distribution files to that directory. 
  224.  
  225.     c) Copy IRC.CMD file into your Maximus directory and check if
  226.        all the paths are specified correctly in there.
  227.  
  228.     d) Copy IRC.MEX (and IRC.VM) to C:\MAX\M directory (or where
  229.        your MEX files are located)
  230.  
  231.     e) Edit MENUS.CTL and add there (where you want) something
  232.        like that:
  233.  
  234.             Mex      M\IRC          Normal    "IRC"
  235.  
  236.           so when a user selects 'I' from your Internet menu, IRC.VM
  237.        mex code will be run. IRC.VM mex code will at first create
  238.        a DOOR.SYS file in your node-dependant directory (for
  239.        single-node BBSs edit IRC.MEX so it would call DOORSYS.BBS
  240.        instead of DOORSYS2.BBS), and then will prompt a user to
  241.        choose the IRC server to use. You can manually change the
  242.           IRC.MEX file to present other (closer) IRC servers to your
  243.        BBS users.
  244.  
  245.     f) Copy DOORSYS2.MEC (and DOORSYS2.BBS) to C:\MAX\MISC
  246.        directory or wherelse your MECCA files are located. Edit
  247.        DOORSYS2.MEC if necessary to specify YOUR BBS node
  248.        directories. By default, DOORSYS2 MECCA script file will
  249.        write DOOR.SYS drop-file in C:\MAX\NODEn directory, where
  250.        'n' is an active node number. Change it if your node
  251.        directories are in different locations, or you are running
  252.        a single node BBS. If you have a single node BBS, simply
  253.        edit IRC.MEX to call DOORSYS.BBS instead of DOORSYS2.BBS,
  254.        and then edit IRC.CMD so it will pass valid path to
  255.        DOOR.SYS file.
  256.  
  257.     g) Compile IRC.MEX with MEX and DOORSYS2.MEC with MECCA (if
  258.        changes were made), compile MENUS.CTL with SILT. Last time
  259.        check whether everything is ok and all paths are correctly
  260.        specified in the files mentioned above.
  261.  
  262.     h) Edit your STARTUP.CMD file in your system root directory
  263.        and add there the following line:
  264.  
  265.         erase c:\ircdoor_home_directory\nodeinfo.* >nul
  266.  
  267.        This command will erase old node information files from the
  268.        IRCDOOR home directory. Ircdoor_home_directory must be
  269.        replaced with the directory name where IRCDOOR/2 files are
  270.        located.
  271.  
  272.        IRCDOOR/2 creates and uses nodeinfo.* files in it's home
  273.        directory and it automatically deletes them when a user
  274.        exits the door. But if you encounter a system crash during
  275.        the time when IRCDOOR is running, you should manually
  276.        remove nodeinfo.* files from it's home directory to prevent
  277.        IRCDOOR from thinking that it is running at the moment.
  278.        That's why the best way to avoid this is to insert that
  279.        mentioned erase command above to your STARTUP.CMD file so
  280.        whenever your system reboots, old IRCDOOR node information
  281.        files will be deleted.
  282.  
  283.   
  284.        Then run Maximus and check it out. If you have problems with
  285.     configuring IRCDOOR/2 for your system, first refer to the
  286.     chapter 5.1 (Installation for non-Maximus BBS systems), and
  287.     if you still have no luck, feel free to write to the author.
  288.     See the information at the bottom of this document to find
  289.     out how to reach me by electronic mail.
  290.  
  291.  
  292.     6.0 IRC commands supported by IRCDOOR/2
  293.  
  294.     The following is a list of IRCII commands currently
  295.     implemented in IRCDOOR/2:
  296.  
  297.         /LIST               Lists all current irc channels, number of
  298.                             users, and topic. (slow and can terminate
  299.                             connection on some servers)
  300.  
  301.         Example on /LIST command: /LIST -min 10
  302.  
  303.  
  304.         /NAMES              Shows the nicknames of all users on each
  305.                             channel
  306.  
  307.         /JOIN <channel>     Join the named channel. All non-commands
  308.                             you type will now go to everyone on that
  309.                             channel. Channel must start with the '#'
  310.                             character. If you are on a channel, the
  311.                             /JOIN command will also automatically
  312.                             get you out of the channel you are cur-
  313.                             rently in, and will bring you to the
  314.                             specified one.
  315.  
  316.         Example on /JOIN command:
  317.           /JOIN #usa
  318.  
  319.         /MSG <nick> <msg>   Sends a private message to the specified
  320.                             person.  Only the specified nickname will
  321.                             see this message.
  322.  
  323.         Example on /MSG command:
  324.           /MSG Hoolio Hello Hoolio!
  325.  
  326.         /NICK <nick>        Change your nickname
  327.                             When you're connected, your BBS login name
  328.                             is usually taken as the default 'nickname'
  329.                             for yourself. You may wish to change this
  330.                             with this command.
  331.  
  332.         Example on /NICK command:
  333.           /NICK IRCD00R
  334.  
  335.         /QUIT or /BYE       Exits IRC.
  336.  
  337.         /HELP               Gets IRCDOOR online help menu. When using
  338.                 online IRCDOOR help system, use ENTER and
  339.                 numeric keys to navigate around. When
  340.                 IRCDOOR displays a [more] message on your
  341.                 screen, you might wish to quit listing by
  342.                 pressing ESCAPE or Q key.
  343.  
  344.         /WHO <channel>      Shows who is on a given channel,
  345.                             including nickname, user name and host,
  346.                             and realname.
  347.  
  348.         /WHOIS <nick>       Shows the "true" indentity of someone
  349.                             Use this often to make sure you know who
  350.                             you are talking to, because nicknames are
  351.                             NOT owned so any number of people could
  352.                             use a nickname.
  353.  
  354.         /WHOWAS <nick>      This command asks for information about a
  355.                             nickname which no longer exists. This may
  356.                             either be due to a nickname change or the
  357.                             user leaving IRC.
  358.  
  359.         /MODE <params>      Allows both usernames and channels to have
  360.                             their mode changed. This can be only used
  361.                             by channel operators. The <params> should
  362.                             contain valid parameters for the /MODE
  363.                             command i.e. the channel name, the
  364.                             nickname (when appropriate), and the /MODE
  365.                             command switches. The following listed are
  366.                             some most used /MODE commands:
  367.  
  368.         /MODE <channel> <+|->o <nick> - take/give the channel operator
  369.                                         privileges for the specified
  370.                                         user.
  371.         /MODE <channel> <+|->i        - change invite-only flag for
  372.                                         the specified channel.
  373.         /MODE <channel> <+|->p        - change private flag for the
  374.                                         specified channel.
  375.         /MODE <channel> <+|->s        - change secret flag for the
  376.                                         specified channel.
  377.         /MODE <channel> <+|->t        - change topic-setable flag for
  378.                                         the specified channel.
  379.         /MODE <channel> <+|->n        - set/unset no messages to
  380.                                         channel from the outside flag.
  381.         /MODE <channel> <+|->m        - change moderated channel flag
  382.                                         for the specified channel.
  383.         /MODE <channel> <+|->l <lim>  - set/unset the user limit to
  384.                                         channel.
  385.         /MODE <channel> <+|->b <user> - set/unset a ban mask to keep
  386.                                         the specified user out of the
  387.                                         channel.
  388.         /MODE <channel> <+|->v <user> - give/take the ability to speak
  389.                                        on the moderated channel.
  390.         /MODE <channel> <+|->k <pass> - set/unset a channel password.
  391.  
  392.         Examples on /MODE command:
  393.           /MODE #latvia -o Kaspariic
  394.           /MODE #gonnabe +b *!*@microsoft.com
  395.  
  396.         /KICK <params>      The KICK command can be used to forcibly
  397.                             remove a user from a channel. It 'kicks
  398.                             them out' of the channel (forced PART).
  399.                             This can only be used by channel opera-
  400.                             tors. The <params> consist of the spaced
  401.                             <channel>, <nick> and <comment> options.
  402.                             Note: the <comment> option is not
  403.                 obligate.
  404.         
  405.         Example on /KICK command: 
  406.           /KICK #ircdoor Lamer Lamers not allowed
  407.  
  408.         /INVITE <params>    The INVITE message is used to invite users
  409.                             to a channel. The <params> should consist
  410.                             from parameter <nickname>, which is the
  411.                             nickname of the person to be invited, and
  412.                             parameter <channel>, which is the target
  413.                             channel to invite the user to.
  414.  
  415.         Example on /INVITE command:
  416.           /INVITE JohnDoe #legends
  417.  
  418.         /TOPIC <params>     The TOPIC message is used to change o
  419.                             view the topic of a channel. The <params>
  420.                             can contain two parameters: the <channel>
  421.                             and the <topic>. The topic for channel
  422.                             specified in the <channel> is returned if
  423.                             there is no <topic> parameter given. If
  424.                             the topic parameter is present, the topic
  425.                             for that channel will be changed, if the
  426.                             channel modes permit this action, and if
  427.                             you are the channel operator.
  428.  
  429.         Example on /TOPIC command:
  430.           /TOPIC #switzerland Weather In Switzerland
  431.  
  432.         /PART <channel>     Lets you leave the specified channel. You
  433.                             may also use the /LEAVE command to leave
  434.                             a channel, but generally you won't need
  435.                             to use this command because /JOIN will
  436.                             automatically get you out of current
  437.                             channel and bring you to the specified one.
  438.  
  439.         /CTCP <nick> <cmd>  The /CTCP command sends a CTCP request
  440.                             to the specified user on IRC. The <cmd>
  441.                             parameter is a valid CTCP request command.
  442.  
  443.         The following are supported CTCP request commands:
  444.  
  445.     CLIENTINFO          Obtains information about other IRCDOOR/2
  446.                 internal CTCP request commands.
  447.     PING            Will generate a reply on remote's "PING"
  448.                 message.
  449.     TIMELEFT        This is internal IRCDOOR/2 CTCP command
  450.                 that let's an IRC user to query how much
  451.                 time is left for the IRCDOOR/2 user.
  452.                 This only applies to remote BBS users.
  453.     USERINFO        Obtains user information on a client. User
  454.                 information includes user's name, city,
  455.                 nickname, IRC server he is connected to,
  456.                 and IRCDOOR/2 version information.
  457.     VERSION                Obtains version information on a client.
  458.                 IRCDOOR/2 version information will be sent.
  459.  
  460.         Examples on /CTCP command:
  461.           /CTCP MisterX CLIENTINFO
  462.           /CTCP JohnDoe VERSION
  463.  
  464.  
  465.         /PING <client>      The PING message is used to test the
  466.                             presence of an active client at the other
  467.                             end of the connection. It can be used to
  468.                             ping clients, servers and nicknames.
  469.  
  470.         /VERSION <server>   The VERSION message is used to query the
  471.                             version of the server program. An optional
  472.                             parameter <server> is used to query the
  473.                             version of the server program which a
  474.                             client is not directly connected to.
  475.                             Note: for getting versions for clients,
  476.                             use the /CTCP <nick> VERSION command.
  477.  
  478.         /SERVER <params>    This command allows you to change current
  479.                             IRC server without exiting the door. This
  480.                             command may not be available if SysOp
  481.                             doesn't want to allow remote users to
  482.                             change IRC servers. The <params> consist
  483.                             of two parameters, <server> and <port>.
  484.                             <server> specifies a server to connect
  485.                             to, and <port> is an optional port number,
  486.                             or 6667 if not specified.
  487.  
  488.         Example on /SERVER command:
  489.           /SERVER irc.funet.fi 6666
  490.  
  491.  
  492.     7.0    IRCDOOR/2-specific commands
  493.  
  494.         /TIMELEFT           The /TIMELEFT command lets the user to
  495.                 check how much time left for his IRC
  496.                 session. This only applies to the remote
  497.                 BBS callers. For local callers, their
  498.                 session time is not limited.
  499.  
  500.         /WHOELSE            The /WHOELSE command lets the user to
  501.                 review who else is using IRC from the
  502.                 same BBS at that present moment.
  503.  
  504.  
  505. 8.    Comments
  506.  
  507.     -------------------------------------------------------------
  508.  
  509.     As you can see, IRCDOOR/2 is full of features that could
  510.     make your BBS users feel happy. There is lot of work spent
  511.     to make the IRCDOOR as good as it is now, and i'd like to
  512.     thank the following people who have been alpha-testing IRCDOOR
  513.     and helped me a lot:
  514.  
  515.     Bob Juge,
  516.         Andy Tarasov
  517.  
  518.     I am also thankful to my wife, Nataly, my father Longin,
  519.     and to all my friends who were understanding me why i
  520.     could not go for holidays, and for their advise on where
  521.     to go next. :)
  522.  
  523.     -------------------------------------------------------------
  524.     Some words about me: i am independent programmer and i
  525.     am interested in job opportunity in other countries.
  526.     I have experience in DOS, Windows and now OS/2 programming,
  527.     and i am looking for a company wishing to employ me at a
  528.     constant or contract job. If you could help me with this,
  529.     please let me know As Soon As Possible!
  530.  
  531.     You are    welcome to visit my WWW home page at SIS, where i am
  532.     currently working, and see my resume at 
  533.  
  534.         http://hpe25.swh.lv/~mrbyte
  535.  
  536.     -------------------------------------------------------------
  537.  
  538.     IRCDOOR/2 Command-line usage:
  539.  
  540.         ircdoor [{-p<handle> -d<dpath>} | {-l}] [-h<hostname>
  541.         -n<nickname> -u<username> -r<realname> -s<server>
  542.         -$<port> -t<time> -k<node>] [flags]
  543.  
  544.     Information about parameters:
  545.  
  546.     -p<handle> specifies an open OS/2 com port "handle" to use.
  547.     <handle> is not a number of open com port, it's a handle that
  548.     os returns when you open com port under OS/2. Normally an OS/2
  549.     BBS can pass a com port handle to an external program, doors,
  550.     etc. Maximus BBS software is a typical example.    However, if
  551.     your BBS software cannot pass a com port handle through 
  552.     command line, you will not be able to run current version of
  553.     IRCDOOR/2 <big sorry>. I am planning to support it in the
  554.     newer version.
  555.  
  556.     -d<path> specifies a full path to created door drop-file.
  557.     The path SHOULD include filename too. Supported drop-files
  558.     are currently DOOR.SYS and DORINFO?.DEF. If i receive
  559.     submissions to add support for more drop-file formats, i will
  560.     be add to do so.
  561.  
  562.     The -p and -d switches specified on command line indicate that
  563.     the door should be run from a BBS, obviously in remote mode.
  564.     See sample OS/2 command file for reference.
  565.  
  566.     -l parameter indicates that the door should be run in local
  567.     mode. Note: if -p or -d (or both) are omitted, the door will
  568.     assume local mode as well. 
  569.  
  570.     -h<hostname> specifies local host name for your machine. This
  571.     is usually localhost, specified in your IAK configs. Local
  572.     host value is used to register a particular IRC user on IRC
  573.     server.
  574.  
  575.     -n<nickname> specifies nickname to use for IRC. By default,
  576.     BBS alias of a user will be read from BBS drop-file, and
  577.     used as nickname. However, it can be specified via command
  578.     line too.
  579.  
  580.     -u<username> specifies local user name on your machine. The
  581.     username and the localhost are two things that construct the
  582.     e-mail address of a IRCDOOR/2 user. If it's not specified,
  583.     username of 'ircdoor' will be used. This option is only
  584.     available in the registered version of IRCDOOR.
  585.  
  586.     -r<realname> indicates user's real name to use for
  587.     registering on IRC server. Realname (as well as nickname) is
  588.     automatically read from BBS drop-file, and presented to a
  589.     user upon the start. This option is only allowed in the
  590.     registered version of IRCDOOR.
  591.  
  592.     -s<server> indicates IRC server name or IP address to connect
  593.     to. Consider using IRC server that is closer to your location.
  594.     There are some servers provided in the IRC.MEX sample code,
  595.     but if you don't live in Scandinavian countries or Baltics,
  596.     consider using other IRC servers than those.
  597.  
  598.     -$<port> parameter is used to specify a port number for the
  599.     server. Normally, it is 6667. This is also by default.
  600.     However, you can always specify a non-standard port number
  601.     for IRC.
  602.  
  603.     -t<time> parameter specifies time (in seconds) for the IRC
  604.     session. This only works in remote mode. If your BBS software
  605.     cannot pass time value in seconds, let me know and i'll add
  606.     support for minutes. :) Note: the value is automatically
  607.     read from BBS drop-file. Override it (if you wish) from the
  608.     command line.
  609.  
  610.     -k<node> parameter specifies a BBS node number, on which
  611.     IRCDOOR is run. This parameter is only required if the node
  612.     information cannot be obtained from the BBS drop-file e.g.
  613.     DORINFO?.DEF, or IRCDOOR is running in local mode.
  614.  
  615.     Now about flags:
  616.  
  617.     Flags are used to toggle some operational stats of the
  618.     IRCDOOR/2. They are specified as a normal switch, and a
  619.     plus "+" or a minus "-" should be added to enable or
  620.     disable a particular option. The following are flags used
  621.     in current version of IRCDOOR/2:
  622.  
  623.     -o    When enabled (through -o+), all remote user's input
  624.         and output will be shown on the sysop's local screen.
  625.         This is useful if you want to see who is doing what
  626.         and where on IRC, ;) but it might consume some system
  627.         resources to display the information on your screen.
  628.         This option is enabled by default.
  629.  
  630.     -------------------------------------------------------------
  631.  
  632.     If you cannot or wish not to setup IRCDOOR/2 with your BBS
  633.     software, but if you would like to see how the door looks
  634.     in practice, feel free to telnet to
  635.  
  636.         bbs.dcbalt.vernet.lv (159.148.150.124)
  637.  
  638.     and see it with your own eyes. You might be able to figure
  639.     out whether it's fair enough to register, then.
  640.  
  641.     What are differences between the registered and unregistered
  642.     versions of IRCDOOR/2?
  643.  
  644.     The following is a list of features that are currently
  645.     disabled in the shareware version, and are fully available
  646.     when you register your copy of IRCDOOR:
  647.  
  648.        - time for the IRC session is limited to 10 minutes. The
  649.          registered version allows to change it to whatever you
  650.          want.
  651.  
  652.            - channel op's commands (/MODE, /KICK, /INVITE, /TOPIC)
  653.          and /CTCP requests aren't available in the shareware
  654.          version. They are fully available in the registered
  655.          version.
  656.  
  657.            - username and realname cannot be changed in the shareware
  658.          version. You might set them only in the registered
  659.          IRCDOOR version.
  660.  
  661.  
  662. 9.    Registration information
  663.  
  664.     As stated in license agreement, IRCDOOR/2 is distributed
  665.     as "shareware". By this, it is meant that an IRCDOOR/2
  666.     user can use the door for a limited time of 28 days, and
  667.     then whether register, or discontinue using it. If you are
  668.     foreign, see USA.FRM for pricing and registration form,
  669.         if you are Latvian, please see the file LATVIA.FRM for
  670.     information on how to register.
  671.  
  672.     If you wish to register, please fill out the entire
  673.     registration form, and send it along with money to the
  674.     address stated below. Only cash payments and direct
  675.     bank transfers are allowed. PLEASE DO NOT SEND CHECKS!
  676.  
  677.     Andrew Eigus
  678.     Vaidavas str. 13-51
  679.     LV-1084 Riga
  680.     Latvia
  681.  
  682.     If you wish to use bank money transfer, here is my bank
  683.     account:
  684.  
  685.     PAREX BANK
  686.     Andrew Eigus
  687.     Acct number: N0702383
  688.  
  689.     Address:
  690.  
  691.     8 Kr. Valdemara
  692.         LV-1010 Riga
  693.         Latvia
  694.     Intl FAX: +371-7-820232
  695.  
  696.  
  697. 10.    IRCDOOR/2 distribution information
  698.  
  699.     Latest shareware versions of IRCDOOR/2 should be obtained from
  700.     the following FTP sites:
  701.  
  702.         ftp.dcbalt.vernet.lv      (*)
  703.           /base2/bbsfiles/comm/bbsdoors/ircdoor/ircdor*.zip
  704.         juge.com          (*)
  705.           /ircdoor/ircdor*.zip
  706.         ftp-os2.cdrom.com
  707.           /pub/os2/network/tcpip/ircdor*.zip or
  708.           /pub/os2/incoming/ircd*.zip
  709.  
  710.     IRCDOOR/2 can be file-requested across Fidonet under magic
  711.     name 'IRCDOOR' from the following nodes:
  712.  
  713.         2:5100/33  (telnet: bbs.dcbalt.vernet.lv) (*)
  714.         1:106/2000 (telnet: juge.com) (*)
  715.  
  716.     (*) - IRCDOOR/2 distribution site.
  717.  
  718. 11.    Contact information
  719.  
  720.     If you encounter problems using the door, find bugs, etc.,
  721.     please feel free to contact the author at one of the
  722.     following e-mail addresses below:
  723.  
  724.     mrbyte@bbs.dcbalt.vernet.lv,
  725.     mrbyte@dcbalt.vernet.lv,
  726.     mrbyte@hpe25.swh.lv,
  727.     aeigus@fgate.castle.riga.lv
  728.  
  729.         or, you can reach me on Fidonet at 2:5100/33 (my BBS), or
  730.     even telnet directly to my BBS (bbs.dcbalt.vernet.lv) and
  731.     leave a comment to the SysOp. If you wish to test the door,
  732.     you can register on my BBS as a new user and try the door
  733.     by yourself.
  734.  
  735.     Happy IRC!
  736.     Andrew Eigus (aka Mr. Byte)
  737.  
  738.     05/Mar/96
  739.  
  740. EOF